PlaceDescription.getLatitude - Code Metrics - Inspection of "reduce duplicate code; close #16" - rootsdev/gedcomx-js - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 40c2b4...09bd06 )

by Justin

created 2016-09-21 21:53 UTC

PlaceDescription.getLatitude A

↳ Parent: src/PlaceDescription.js

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
c	1
b	0
f	0
nc	1
nop	0
dl	0
loc	3
rs	10

var Subject = require('./Subject'),
    ResourceReference = require('./ResourceReference'),
    TextValue = require('./TextValue'),
    GDate = require('./Date'),
    utils = require('./utils');

/**
 * A description of a place
 * 
 * @constructor
 * @param {Object} [json]

 */
var PlaceDescription = function(json){
  
  // Protect against forgetting the new keyword when calling the constructor
  if(!(this instanceof PlaceDescription)){
    return new PlaceDescription(json);
  }
  
  // If the given object is already an instance then just return it. DON'T copy it.
  if(PlaceDescription.isInstance(json)){
    return json;
  }
  
  Subject.call(this, json);
  
  if(json){
function isBig(a) {
    if (a > 5000) {
        return "yes";
    }
}

console.log(isBig(5001)); //returns yes
console.log(isBig(42)); //returns undefined
    this.setType(json.type);
    this.setNames(json.names);
    this.setPlace(json.place);
    this.setJurisdiction(json.jurisdiction);
    this.setTemporalDescription(json.temporalDescription);
    this.setSpatialDescription(json.spatialDescription);
    this.setLatitude(json.latitude);
    this.setLongitude(json.longitude);

  }
};

PlaceDescription.prototype = Object.create(Subject.prototype);

PlaceDescription._gedxClass = PlaceDescription.prototype._gedxClass = 'GedcomX.PlaceDescription';

/**
 * Check whether the given object is an instance of this class.
 * 
 * @param {Object} obj
 * @returns {Boolean}
 */
PlaceDescription.isInstance = function(obj){
  return utils.isInstance(obj, this._gedxClass);
};

/**
 * Get the type
 * 
 * @returns {String}
 */
PlaceDescription.prototype.getType = function(){
  return this.type;
};

/**
 * Set the type
 * 
 * @param {String} type
 * @returns {PlaceDescription}
 */
PlaceDescription.prototype.setType = function(type){
  this.type = type;
  return this;
};

/**
 * Get the names
 * 
 * @returns {TextValue[]}
 */
PlaceDescription.prototype.getNames = function(){
  return this.names || [];
};

/**
 * Set the names
 * 
 * @param {TextValue[]|Object[]} names
 * @returns {PlaceDescription}
 */
PlaceDescription.prototype.setNames = function(names){
  return this._setArray(names, 'names', 'addName');
};

/**
 * Add the name
 * 
 * @param {TextValue|Object} name
 * @returns {PlaceDescription}
 */
PlaceDescription.prototype.addName = function(name){
  return this._arrayPush(name, 'names', TextValue);
};

/**
 * Get the place
 * 
 * @returns {ResourceReference}
 */
PlaceDescription.prototype.getPlace = function(){
  return this.place;
};

/**
 * Set the place
 * 
 * @param {ResourceReference} place
 * @returns {PlaceDescription}
 */
PlaceDescription.prototype.setPlace = function(place){
  if(place){
    this.place = ResourceReference(place);
  }
  return this;
};

/**
 * Get the jurisdiction
 * 
 * @returns {ResourceReference}
 */
PlaceDescription.prototype.getJurisdiction = function(){
  return this.jurisdiction;
};

/**
 * Set the jurisdiction
 * 
 * @param {ResourceReference} jurisdiction
 * @returns {PlaceDescription}
 */
PlaceDescription.prototype.setJurisdiction = function(jurisdiction){
  if(jurisdiction){
    this.jurisdiction = ResourceReference(jurisdiction);
  }
  return this;
};

/**
 * Get the latitude
 * 
 * @returns {Number}
 */
PlaceDescription.prototype.getLatitude = function(){
  return this.latitude;
};

/**
 * Set the latutide
 * 
 * @param {Number} latitude
 * @returns {PlaceDescription}
 */
PlaceDescription.prototype.setLatitude = function(latitude){
  this.latitude = latitude;
  return this;
};

/**
 * Get the longitude
 * 
 * @returns {Number}
 */
PlaceDescription.prototype.getLongitude = function(){
  return this.longitude;
};

/**
 * Set the latutide
 * 
 * @param {Number} longitude
 * @returns {PlaceDescription}
 */
PlaceDescription.prototype.setLongitude = function(longitude){
  this.longitude = longitude;
  return this;
};

/**
 * Get the temporal description
 * 
 * @returns {Date}
 */
PlaceDescription.prototype.getTemporalDescription = function(){
  return this.temporalDescription;
};

/**
 * Set the temporal description
 * 
 * @param {Date} date
 * @returns {PlaceDescription}
 */
PlaceDescription.prototype.setTemporalDescription = function(date){
  if(date){
    this.temporalDescription = GDate(date);
  }
  return this;
};

/**
 * Get the spatial description
 * 
 * @returns {ResourceReference}
 */
PlaceDescription.prototype.getSpatialDescription = function(){
  return this.spatialDescription;
};

/**
 * Set the spatial description
 * 
 * @param {ResourceReference} spatial
 * @returns {PlaceDescription}
 */
PlaceDescription.prototype.setSpatialDescription = function(spatial){
  if(spatial){
    this.spatialDescription = ResourceReference(spatial);
  }
  return this;
};

/**
 * Export the object as JSON
 * 
 * @return {Object} JSON object
 */
PlaceDescription.prototype.toJSON = function(){
  return this._toJSON(Subject, [
    'type',
    'names',
    'place',
    'jurisdiction',
    'latitude',
    'longitude',
    'temporalDescription',
    'spatialDescription'
  ]);
};

module.exports = PlaceDescription;

1			var Subject = require('./Subject'),
2			ResourceReference = require('./ResourceReference'),
3			TextValue = require('./TextValue'),
4			GDate = require('./Date'),
5			utils = require('./utils');
6
7			/**
8			* A description of a place
9			*
10			* @constructor
11			* @param {Object} [json]
			0 ignored issues – show Documentation introduced 2016-05-27 14:53 UTC by Report Bug Copy Issue Report The parameter `[json]` does not exist. Did you maybe forget to remove this comment? Loading history...
12			*/
13			var PlaceDescription = function(json){
14
15			// Protect against forgetting the new keyword when calling the constructor
16			if(!(this instanceof PlaceDescription)){
17			return new PlaceDescription(json);
18			}
19
20			// If the given object is already an instance then just return it. DON'T copy it.
21			if(PlaceDescription.isInstance(json)){
22			return json;
23			}
24
25			Subject.call(this, json);
26
27			if(json){
			0 ignored issues – show Complexity Best Practice introduced 2016-05-27 14:53 UTC by Report Bug Copy Issue Report There is no return statement if `json` is `false`. Are you sure this is correct? If so, consider adding `return;` explicitly. This check looks for functions where a `return` statement is found in some execution paths, but not in all. Consider this little piece of code function isBig(a) { if (a > 5000) { return "yes"; } } console.log(isBig(5001)); //returns yes console.log(isBig(42)); //returns undefined The function `isBig` will only return a specific value when its parameter is bigger than 5000. In any other case, it will implicitly return `undefined`. This behaviour may not be what you had intended. In any case, you can add a `return undefined` to the other execution path to make the return value explicit. Loading history...
28			this.setType(json.type);
29			this.setNames(json.names);
30			this.setPlace(json.place);
31			this.setJurisdiction(json.jurisdiction);
32			this.setTemporalDescription(json.temporalDescription);
33			this.setSpatialDescription(json.spatialDescription);
34			this.setLatitude(json.latitude);
35			this.setLongitude(json.longitude);
			0 ignored issues – show Best Practice introduced 2016-05-27 14:53 UTC by Report Bug Copy Issue Report There is no `return` statement in this branch, but you do return something in other branches. Did you maybe miss it? If you do not want to return anything, consider adding `return undefined;` explicitly. Loading history...
36			}
37			};
38
39			PlaceDescription.prototype = Object.create(Subject.prototype);
40
41			PlaceDescription._gedxClass = PlaceDescription.prototype._gedxClass = 'GedcomX.PlaceDescription';
42
43			/**
44			* Check whether the given object is an instance of this class.
45			*
46			* @param {Object} obj
47			* @returns {Boolean}
48			*/
49			PlaceDescription.isInstance = function(obj){
50			return utils.isInstance(obj, this._gedxClass);
51			};
52
53			/**
54			* Get the type
55			*
56			* @returns {String}
57			*/
58			PlaceDescription.prototype.getType = function(){
59			return this.type;
60			};
61
62			/**
63			* Set the type
64			*
65			* @param {String} type
66			* @returns {PlaceDescription}
67			*/
68			PlaceDescription.prototype.setType = function(type){
69			this.type = type;
70			return this;
71			};
72
73			/**
74			* Get the names
75			*
76			* @returns {TextValue[]}
77			*/
78			PlaceDescription.prototype.getNames = function(){
79			return this.names \|\| [];
80			};
81
82			/**
83			* Set the names
84			*
85			* @param {TextValue[]\|Object[]} names
86			* @returns {PlaceDescription}
87			*/
88			PlaceDescription.prototype.setNames = function(names){
89			return this._setArray(names, 'names', 'addName');
90			};
91
92			/**
93			* Add the name
94			*
95			* @param {TextValue\|Object} name
96			* @returns {PlaceDescription}
97			*/
98			PlaceDescription.prototype.addName = function(name){
99			return this._arrayPush(name, 'names', TextValue);
100			};
101
102			/**
103			* Get the place
104			*
105			* @returns {ResourceReference}
106			*/
107			PlaceDescription.prototype.getPlace = function(){
108			return this.place;
109			};
110
111			/**
112			* Set the place
113			*
114			* @param {ResourceReference} place
115			* @returns {PlaceDescription}
116			*/
117			PlaceDescription.prototype.setPlace = function(place){
118			if(place){
119			this.place = ResourceReference(place);
120			}
121			return this;
122			};
123
124			/**
125			* Get the jurisdiction
126			*
127			* @returns {ResourceReference}
128			*/
129			PlaceDescription.prototype.getJurisdiction = function(){
130			return this.jurisdiction;
131			};
132
133			/**
134			* Set the jurisdiction
135			*
136			* @param {ResourceReference} jurisdiction
137			* @returns {PlaceDescription}
138			*/
139			PlaceDescription.prototype.setJurisdiction = function(jurisdiction){
140			if(jurisdiction){
141			this.jurisdiction = ResourceReference(jurisdiction);
142			}
143			return this;
144			};
145
146			/**
147			* Get the latitude
148			*
149			* @returns {Number}
150			*/
151			PlaceDescription.prototype.getLatitude = function(){
152			return this.latitude;
153			};
154
155			/**
156			* Set the latutide
157			*
158			* @param {Number} latitude
159			* @returns {PlaceDescription}
160			*/
161			PlaceDescription.prototype.setLatitude = function(latitude){
162			this.latitude = latitude;
163			return this;
164			};
165
166			/**
167			* Get the longitude
168			*
169			* @returns {Number}
170			*/
171			PlaceDescription.prototype.getLongitude = function(){
172			return this.longitude;
173			};
174
175			/**
176			* Set the latutide
177			*
178			* @param {Number} longitude
179			* @returns {PlaceDescription}
180			*/
181			PlaceDescription.prototype.setLongitude = function(longitude){
182			this.longitude = longitude;
183			return this;
184			};
185
186			/**
187			* Get the temporal description
188			*
189			* @returns {Date}
190			*/
191			PlaceDescription.prototype.getTemporalDescription = function(){
192			return this.temporalDescription;
193			};
194
195			/**
196			* Set the temporal description
197			*
198			* @param {Date} date
199			* @returns {PlaceDescription}
200			*/
201			PlaceDescription.prototype.setTemporalDescription = function(date){
202			if(date){
203			this.temporalDescription = GDate(date);
204			}
205			return this;
206			};
207
208			/**
209			* Get the spatial description
210			*
211			* @returns {ResourceReference}
212			*/
213			PlaceDescription.prototype.getSpatialDescription = function(){
214			return this.spatialDescription;
215			};
216
217			/**
218			* Set the spatial description
219			*
220			* @param {ResourceReference} spatial
221			* @returns {PlaceDescription}
222			*/
223			PlaceDescription.prototype.setSpatialDescription = function(spatial){
224			if(spatial){
225			this.spatialDescription = ResourceReference(spatial);
226			}
227			return this;
228			};
229
230			/**
231			* Export the object as JSON
232			*
233			* @return {Object} JSON object
234			*/
235			PlaceDescription.prototype.toJSON = function(){
236			return this._toJSON(Subject, [
237			'type',
238			'names',
239			'place',
240			'jurisdiction',
241			'latitude',
242			'longitude',
243			'temporalDescription',
244			'spatialDescription'
245			]);
246			};
247
248			module.exports = PlaceDescription;

rootsdev / gedcomx-js

Push — master ( 40c2b4...09bd06 )

PlaceDescription.getLatitude A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like